home *** CD-ROM | disk | FTP | other *** search
/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d11 / vde151.arc / VINSTALL.DOC < prev    next >
Text File  |  1990-03-29  |  42KB  |  736 lines
  1.  
  2.  
  3.                                  VINST151.DOC
  4.                                  ------------ 
  5.                           [Supplement to VDE151.DOC]
  6.  
  7.                  Instructions for Macros and VINSTALL utility
  8.  
  9.                             (c)1987-90 Eric Meyer
  10.  
  11.  
  12. ================================  CONTENTS  ==================================
  13.                                  (continued)
  14.  
  15. 6. MACROS.  Explanation and examples of:
  16.         Function keys, Key redefinition files, Macros, Macro keys, Macro
  17.      programming, Recording macros.
  18.  
  19. 7. RUNNING VINSTALL.  How to use VINSTALL.COM to modify VDE.COM.:
  20.  
  21.    A. INSTALLATION.  Installing for different computer hardware:
  22.       ============   Screen size; IBM compatibility; Colors; Fonts; Snow.
  23.  
  24.    B. USER OPTIONS.  Customization of many initial VDE settings.
  25.  
  26.    C. PRINTER INSTALLATION.  Using special printer features:
  27.                           print modes, graphics, etc.
  28.  
  29.    D. DEFAULT MACRO KEYS.  Installing a default set of macro keys.
  30.  
  31.    E. DEFAULT FUNCTION KEYS.  Installing the function keys.
  32.  
  33.    F. GRAPHICS.  Modifying the default set of graphics characters.
  34.  
  35.    G. CHARACTER WIDTHS.  Modifying the default set of character widths.
  36.  
  37.    H. RESTORE DEFAULTS.  Undoing previous modifications.
  38.  
  39.  
  40.  
  41.  
  42. ================================  6. MACROS  =================================
  43.                              (Command mode only)
  44.  
  45.      Macros are a sophisticated and powerful tool for automating repetitive 
  46. tasks.  A "macro" is a string of VDE commands and/or text that you can type in 
  47. once and then have repeated automatically.  (Note: for large pieces of boiler- 
  48. plate text, read in disk files with ^KR instead.)  A "function key" is a macro 
  49. assigned to one of the [F1]...[F40] keys, while a "macro key" is a macro 
  50. assigned to a key Esc0...9 or EscA...Z; these can all be defined either while 
  51. editing, or with VINSTALL.  "Macro programming" involves the use of special 
  52. commands allowing a macro to perform more complex operations including loops 
  53. and conditional execution, much like a programming language.
  54.      VDE's 76 user-definable macros allow you to customize it for any task, 
  55. such as the formatting requirements of specialized professional writing, or 
  56. many programming languages.  Many examples are given below.
  57.  
  58.      To create a macro, while editing, you can:
  59.          (1) use the Esc[ command, and type the necessary keystrokes at the 
  60.     prompt.  You may want to plan or compose the macro first, using pen and 
  61.     paper.  Certain keystrokes, like [Ret] or ^X, are line editing commands, 
  62.     and must be preceded by a ^P to enter them into the macro; the input line 
  63.     has a 65-key limit.  See MACROS, PROMPTS.
  64.          (2) use the Esc" command.  Type the desired keystrokes, exactly as 
  65.     you would while editing: no ^P prefixes are required, and you will see the 
  66.     results as you type.  There is a 128-key limit.  See RECORDING MACROS.
  67.  
  68.      Macros execute EXACTLY as though you had typed the given keys yourself.  
  69. EXAMPLE: to read in a letterhead file called LETTER.HDR at the top of your 
  70. file, you would type:
  71.               ^QR         to get to the top of the file
  72.               ^KR         to read in a file
  73.               LETTER.HDR  to specify filename at the "Read file:" prompt
  74.               [Ret]       to end the filename input
  75. So this is exactly what you need to enter in your macro.  Note that ALL the 
  76. input -- every keystroke, including answers to prompts, [Ret] keystrokes, and 
  77. so on -- MUST be included.  For further details see MACROS.
  78.  
  79.      Note that the results of a macro may depend on various settings at the 
  80. time it is run!  A problem of sorts arises with "toggles" -- commands that 
  81. reverse a state -- since the macro doesn't know what state they were in to 
  82. begin with.  So macros that employ ^OS, ^OV, and other similar commands must 
  83. be used with care -- be sure everything is set properly before invoking them.
  84.      There is one exception: the Insert toggles (^V,^]) are so much of a 
  85. problem that VDE actually turns INSERT OFF before running any macro, so you 
  86. can be sure that you are initially NOT in insert mode, or, that when the first 
  87. ^V or ^] is encountered in the macro, you ARE.  Thus the macro "Hello" will 
  88. overwrite any existing text, while "^VHello" will insert -- regardless of the 
  89. insert status when the macro is used.  The previous status is restored when 
  90. the macro terminates.
  91.  
  92.      Once again, ordinarily macros are completely self-contained, and NEVER 
  93. request input from the keyboard while running.  There are two exceptions:
  94.          (1) If a reformat (^B) operation is in progress and 
  95.       dehyphenation is required, the "Remove?" prompt will appear in 
  96.       the header and a "Y/N" answer will be necessary to continue.  
  97.       (This is a decision the macro can't make.)  See REFORMAT.
  98.          (2) Using the AltR command in macros is tricky: input while 
  99.       running a program must come from the keyboard.  (VDE resumes 
  100.       control only when the program ends.)  See RUN COMMAND.
  101.  
  102.  
  103.                                  USING MACROS
  104.  
  105. FUNCTION KEYS ([F1]...[F40]) -  Up to 40 macros can be assigned to function 
  106.     keys; they can then be recalled and used with one keystroke.  Each of the 
  107.     10 IBM function keys can be used with Shift, Ctrl, or Alt, to produce:
  108.               Shift-[F1]...[F10]  =  [F11]...[F20]
  109.                Ctrl-[F1]...[F10]  =  [F21]...[F30]
  110.                 Alt-[F1]...[F10]  =  [F31]...[F40]
  111.     The new Extended (101-key) keyboards actually have extra keys labeled 
  112.     [F11] and [F12]; VDE will not recognize these keys.
  113.          Otherwise, function keys are defined (with the Esc[ or Esc] command, 
  114.     or with VINSTALL) and used exactly like macro keys.  See MACRO KEYS.
  115.  
  116. KEY DEFINITION FILES (AltU) -  These files save sets of macro key or function 
  117.     key definitions, and should be given file types of ".VDK" and ".VDF", 
  118.     respectively.  You can load any key file, along with your text file to 
  119.     edit, from the command line (see SYNTAX).  In addition, they can be loaded 
  120.     or saved with the AltU command while editing in VDE, and can also be 
  121.     created or installed as defaults in your copy of VDE with the VINSTALL 
  122.     program (see below).
  123.          The AltU command will ask whether you want to "L"oad or "S"ave such a 
  124.     file, then prompt for the name of the file.  The filetype MUST be ".VDK" 
  125.     or ".VDF", and will determine whether MACRO or FUNCTION keys are affected.  
  126.     If you load such a file, those definitions will replace any previous ones.  
  127.     If you save, the current definitions will be written to the file.
  128.  
  129. MACROS (Esc[,]) -  When you are in the middle of doing something in VDE, and 
  130.     find that you need to do something many times, it may be less tedious to 
  131.     have it repeated automatically.  If you type Esc[ you will be asked first 
  132.     for the string to execute; then, whether you want to Use or Store it.  (On 
  133.     storing keys, see MACRO KEYS.)
  134.          If you Use the macro, you will be asked for an optional "Quiet" 
  135.     designation, then a "Repeat count".  You can speed up macro execution by 
  136.     specifying "Quiet" mode: only the header will be updated as the macro 
  137.     runs.  (Don't do this if the macro concludes by requesting user input -- 
  138.     the necessary prompts would not display!)  For the repeat count, you can 
  139.     type a number of times to repeat (0-254), or "*" for indefinitely.  You 
  140.     will see the results as the macro executes, and you can abort it at any 
  141.     time by pressing Esc.
  142.          Macros also stop if an error occurs; the error message will be 
  143.     visible, and can be cleared by pressing Esc.  Many commands (like Find or 
  144.     Reformat) are designed to generate errors at the end of the file so that 
  145.     an indefinite ("*") macro containing them will halt there.  Other indef- 
  146.     inite macros may need to be aborted manually.
  147.          Once defined, a macro can be re-used with the Esc] command, which 
  148.     again gives you the options to Use or Store the previously defined macro.
  149.          In order to include any input line editing characters (BS (^H), [Ret] 
  150.     (^M), ^J, ^X, ^U, ^P) in a macro, you must prefix them with ^P.  (NOTE:  
  151.     To make them easier to read and understand, macro listings will be given 
  152.     here as they function, not as they are typed in.  ^P prefixes as needed 
  153.     are NOT shown: remember that you need to add them!  Keystrokes are often 
  154.     separated by spaces for clarity; the "_" symbol is used to represent an 
  155.     actual space character typed.  Here are some sample macros:
  156.          1.  Reformat an entire file (Wordstar ^QQB): after Esc[, just enter
  157.                                   ^B
  158.     Specify quiet and indefinite repeat as options ("Q*").
  159.          2.  View a file by scrolling slowly through it:
  160.                                Esc; ^C
  161.     This will pause, then scroll down.  (Use a repeat count of "*".)
  162.          3.  Enter a long graphics border for a box.  (This can get tedious by 
  163.     hand.)  Assuming graphic "Y" is the horizontal bar,
  164.                                AltG Y
  165.     will enter one character.  You can get a line 40 characters long by giving 
  166.     a repeat count of "40" (and the "Q"uiet option will avoid unnecessarily 
  167.     displaying the menu).
  168.          4.  Can you figure out what this one does, if entered with a repeat 
  169.     count of "*"?  (Answer:  .elif eht fo dne eht ta meht fo tsil a gnikam 
  170.     elif a fo tuo sesehtnerap ni stnemmoc ekat lliw tI)
  171.                 ^QR ^QF(^J ^G ^KB ^QF)^J ^G ^KK ^QC [Ret] ^KV
  172.          VDE macros are very powerful tools, particularly given their program 
  173.     ability and storage on macro Keys.
  174.  
  175. MACRO KEYS (Esc0...Z) -  Both the Esc[ and Esc] commands also give the option 
  176.     of storing the macro definition to a MACRO KEY.  Up to 36 of these can be 
  177.     stored on keys 0...9,A...Z; they can then be called up with two 
  178.     keystrokes.  (40 more can be stored on IBM function keys; see FUNCTION 
  179.     KEYS.)  Example: if stored to key 3, a macro can be reused simply by 
  180.     typing Esc3.
  181.          Ordinarily, macro keys operate just like the original macro:  they 
  182.     will ask for a "Repeat count" when executed.  In many cases (boilerplate 
  183.     text, for example), you will want a key to execute only once when invoked; 
  184.     if so, specify "N"o-repeat when storing the definition to a key.  Or you 
  185.     can instead specify "Q"uiet, if you also want the key to run in Quiet mode 
  186.     (to increase speed and minimize display activity).
  187.          There is a total of 982 bytes available for all 36 keys, and a 128 
  188.     byte limit for any one key.  (VDE's own input line will only accept 65 
  189.     bytes, but VINSTALL can handle up to the full 128.)  Trying to use an 
  190.     undefined key results in an error.  You can delete a key definition by 
  191.     entering an empty macro string (Esc[, CR) and storing it to the key.  Keys 
  192.     defined with Esc] are of course temporary.  (VINSTALL lets you install 
  193.     definitions permanently; see DEFAULT MACRO/FUNCTION KEYS.)
  194.  
  195.          EXAMPLES: Besides simply storing any macro, these Keys are useful for 
  196.     storing a frequently repeated phrase; "EscW" is much more convenient than 
  197.     "World Wide Widgets Ltd. (N.A.)".  You might also define one as a common 
  198.     command like ^PS, for underlining; or a set of margins, like ^OR60[Ret] 
  199.     ^OL5[Ret].  A key defined as ^QR ^N AltD ^OF would place the current date 
  200.     at the top right of a letter.
  201.  
  202. MACRO PROGRAMMING (Esc0...Z,!,=,~,(),+,-,&,;) -  VDE has several commands that 
  203.     operate only within a macro definition, and give you conditional control 
  204.     over the execution of a macro, allowing real programming.
  205.          Esc0...Z, when placed IN a macro, function simply as "labels" 0...Z.  
  206.     They have no effect, but can be "jumped" to by other commands.
  207.          Esc! followed by 0...Z is a "jump" instruction, causing macro 
  208.     execution to resume with the command following that label.  Example: Esc!2 
  209.     jumps to label 2.  As two special cases, Esc![ jumps to the beginning of 
  210.     the macro, and Esc!] jumps to the end (aborts).
  211.          Esc= and Esc~ perform tests on the character at the current cursor 
  212.     position.  There are two ways to use them:
  213.              (1) Followed by a character, then a label 0...Z (or 
  214.         "[","]"), they are conditional jumps: they jump IF the 
  215.         character does (or for "~", does NOT) match the one 
  216.         specified.  Example: Esc~^M2 jumps to label 2 if the current 
  217.         character is NOT a CR.
  218.              (2) Followed by a character, then ">" or "<", they are 
  219.         search loops.  They will continue to move the cursor right 
  220.         (or for "<", left) as long as the character at the cursor 
  221.         does (or for "~", doesn't) match, or until the beginning or 
  222.         end of the file.  Example: Esc=_> moves right as long as the 
  223.         current character is a space (so it stops on a NONspace).
  224.          Several commands allow the use of a counter variable.  Esc() sets 
  225.     the value: for example, Esc(0) initializes it to zero.  The Esc+ command 
  226.     simply increments the value; Esc- (minus) decrements the value, then jumps 
  227.     if it is zero to a specified label.  (In addition to a number, you may use 
  228.     "[" or "]" for the start or end of the macro, or "@" to avoid jumping 
  229.     entirely.)  Example: Esc-] decrements the counter, jumping to the end 
  230.     (exiting) if it reaches zero.
  231.          Esc&, followed by 0...Z, is used to "chain" to another macro key.  In 
  232.     this way you can build up strings longer than the 65/128-byte limit on any 
  233.     one key.  This is a "jump", not a "call"; there is no returning.  Example: 
  234.     Esc&M causes key M to execute.  (You cannot chain to function keys.)
  235.          Esc; (semicolon) gives a brief pause before execution continues, 
  236.     presumably so the user can see what's happening on screen.
  237.          Macro programs are stored just like any other macro string (usually 
  238.     as No-repeat).  If you program an endless loop, you will at some point 
  239.     have to abort by pressing Esc.  Don't make macro programs Quiet until 
  240.     you're sure they work.
  241.  
  242.          EXAMPLE 1: here is a good macro program (best stored as a Quiet key) 
  243.     to move the cursor to the start of the current sentence:
  244.                  Esc~.1 ^S Esc1 Esc~.< Esc2 ^D Esc=_2 Esc=^M2
  245.     You could write this out in programmer's pseudo-code as:
  246.               If not "." goto label1
  247.               Move left                 ;move left if already on period
  248.      label1:  While not "." move left   ;move left to previous period
  249.      label2:  Move right                ;now move back right
  250.               If " " goto label2        ;  as long as you see a space
  251.               If "^M" goto label2       ;  or a Return
  252.               (all done)
  253.          EXAMPLE 2: a macro to move to the start of the current paragraph:
  254.                  ^QS ^S^S Esc=_[ ^D^D
  255.          EXAMPLE 3: if you have some text that you can't reformat because 
  256.     every line ends in HARD CRs, here is a macro that will "soften up" one 
  257.     paragraph's worth, leaving just one HARD CR at the end:
  258.                  ^QS ^X Esc=_] Esc=^M] ^S ^V_^V ^D Esc![
  259.          EXAMPLE 4: a macro to delete a word to the LEFT of the cursor:
  260.                  ^S Esc~_2 Esc1 ^G^S Esc=_1 Esc2 ^G^S Esc~_2 ^D
  261.          EXAMPLE 5: a macro to match parentheses.  Many programming languages 
  262.     use nested sets of parentheses, for example "{}" in C.  This program, when 
  263.     the cursor is placed on an open bracket "{", will move ahead to find the 
  264.     closed bracket "}" that matches it:
  265.                  Esc~{] Esc(0) Esc1 Esc~{2 Esc+ Esc!3
  266.                                Esc2 Esc~}3 Esc-]
  267.                                Esc3 ^D Esc!1
  268.  
  269. RECORDING MACROS (Esc") - As an alternative to composing macros and using the 
  270.     Esc[ command to type them in, you can simply record a macro from a 
  271.     sequence of keystrokes as you go about a task.  Press Esc" to activate 
  272.     recording; type away; then press Esc" again to conclude.  You will then be 
  273.     asked whether to use or store it, etc (see MACROS).  No confusing ^P 
  274.     prefixes are needed, and you can take advantage of the full 128-key length 
  275.     limit.  While recording, a quote mark (") will be visible in the upper 
  276.     right (prefix) area of the header, if the header is displayed.
  277.          Note: function and macro key commands themselves will not work while 
  278.     macro recording is in progress.
  279.  
  280.  
  281. ==========================  7. RUNNING VINSTALL  =============================
  282.  
  283.  
  284.      VINSTALL is a utility that lets you customize your copy of the VDE 
  285. editor.  A few choices will be important from the first: for example, VDE 
  286. operates by default in Command mode, and if you prefer MenuBar mode you will 
  287. need to change this with VINSTALL.  There are many more options that you need 
  288. not concern yourself with at first: in the course of using VDE, you will 
  289. discover how you want these things set.  However, there are important changes 
  290. you will need to make to VDE before using it, if you have a computer that:
  291.               * Is not fully IBM compatible (BIOS, video).
  292.               * Experiences "snow" problems with programs that write
  293.                  directly to video memory (older style CGA adapters).
  294.      You should begin using VINSTALL soon; once you have modified VDE.COM, the 
  295. introductory messages in VDE and VINSTALL will no longer appear.
  296.  
  297.      Your copies of the program files will be called VDE.COM and VINSTALL.COM, 
  298. though of course you can rename them (I usually call them V.COM and VI.COM).  
  299. To run VINSTALL simply type:
  300.               C>vinstall              if your copy is still called "VDE.COM"
  301.         or    C>vinstall V.COM        if it's called "V.COM" (or whatever).
  302.      Notes: VINSTALL modifies the file VDE.COM; always keep an unmodified 
  303. original copy of all VDE files in case problems arise!  The version numbers of 
  304. VINSTALL and VDE (and any auxiliary key or printer files, see below) must 
  305. agree, or you will get an error.
  306.  
  307.      VINSTALL is fully menu-driven; it will present you with a set of 
  308. categories that corresponds to each section below, starting with Installation; 
  309. you select the values you want to change.  The program is largely self- 
  310. documenting, and steps you through each item individually.  If this is your 
  311. first time, take advantage of its "Help" option before you start in, for some 
  312. basic instructions.  You may also find a good ASCII chart helpful for 
  313. deciphering your printer codes.  VINSTALL uses several types of data entry:
  314.      TEXT - Just type in the character(s).
  315.      LOGICAL - Yes/No.  Just type "Y" or "N".
  316.      DECIMAL - Enter a number from 0 to 255.
  317.      HEX - Enter a two-digit hex byte value 00-FF.  (Don't omit lead zeros.)
  318.      BYTE STRINGS - fixed length: enter the required number of hex bytes.
  319.                     variable: enter the (hex) count for the number of bytes, 
  320.               followed by the bytes themselves.  Example:  (02)1B3D.  The max- 
  321.               imum length is given in square brackets [#].  This format is 
  322.               referred to below as "(#),bytes".
  323. VINSTALL can't check for illegal values; be careful what you enter!
  324.  
  325.      At most points in VINSTALL, you can press Esc to return immediately to 
  326. the Main Menu, or ^C to abort the program.
  327.  
  328.  
  329. -----------------------------  A. INSTALLATION  ------------------------------
  330.  
  331.  
  332.      VDE will not run properly on computers that are not 100% IBM compatible, 
  333. unless you use VINSTALL to provide the necessary display information.  (Note: 
  334. the HP Portable Plus is also supported, as a "near compatible".)
  335.      The IBM PC installation gives the best performance, but requires an IBM 
  336. standard BIOS and a supported video adapter (MDA,CGA,EGA,VGA).  You can 
  337. customize the display (colors, fonts etc) to your preferences.
  338.      The non-IBM installation will run on any system that supports ANSI 
  339. standard screen control sequences (eg, the ANSI.SYS screen driver -- you must 
  340. have the statement DEVICE=ANSI.SYS or equivalent in your CONFIG.SYS file).  
  341. You must also specify the size of your screen.  This installation can of 
  342. course also be used on IBM compatibles, in the event that direct video access 
  343. is undesirable.  It will even work in "remote" applications, such as high- 
  344. speed modem connections, with appropriate terminal software on the user's end.
  345.  
  346. IBM PC PARAMETERS:
  347.  
  348. Screen colors - you can select six video attribute bytes: one for normal text; 
  349.     one for block text; one for soft CR markers; one for the header; one for 
  350.     menus and prompts; and one for highlights (prompts, etc). Each is two hex 
  351.     digits, for a background and foreground color.  You will see a color 
  352.     palette displayed on screen; the color digits are:
  353.            *0 = BLACK   4 = red      *8 = GREY       C = lt red
  354.             1 = blue    5 = magenta   9 = lt blue    D = lt magenta
  355.             2 = green   6 = brown     A = lt green   E = yellow
  356.             3 = cyan   *7 = WHITE     B = lt cyan   *F = BRIGHT WHITE
  357.     (* - All monochrome screens can display BLACK, WHITE, and BRIGHT WHITE; in 
  358.     some cases, GREY may also be visible.)
  359.          Any digit may be used for the the foreground, but only 0-7 for 
  360.     background (8-F produce blinking video...  ugh).  You will probably want 
  361.     the header and highlight attributes to have the same background.
  362.  
  363. Make cursor "D"efault,"B"lock,"U"nderline (D/B/U) - You can choose the cursor 
  364.     type you want during editing.  Choose "D"efault to leave it whatever it 
  365.     was before VDE was run.
  366. Problems with CGA snow (Y/N) - Normally No.  Some older CGA cards experience 
  367.     ugly "snow" when programs write directly to video memory.  If this happens 
  368.     to you, select "Y", and VDE will time its video access according to 
  369.     horizontal retrace intervals.  (Display speed will be slightly reduced.)
  370.  
  371. NON-IBM PC PARAMETERS: (automatically set for IBM PC)
  372.  
  373. Clock speed in MHz - Set this decimal value to reflect your CPU clock speed. 
  374.     Common values are 5 (for 4.77), 8, 10, 12, etc.  Adjust the value if 
  375.     desired to change the length of delays in VDE.  (At present this involves 
  376.     only the "Esc;" macro command and the horizontal scroll delay.)
  377.  
  378. Terminal init - enter an optional string of code (#),bytes to be sent to the 
  379.     screen after clearing the screen, whenever (re)entering VDE.
  380. Terminal uninit - enter an optional string of code (#),bytes to be sent to the 
  381.     screen upon exiting from VDE back to DOS.
  382.  
  383. Viewable columns (80-255) - normally 80; set to the column width of your 
  384.     display, if different.
  385. Viewable lines (16-255) - normally 25; if you have a shorter or longer default 
  386.     display (on entry to VDE), enter the length here.
  387. Fast scroll supported (Y/N) - Does your computer respond to the ANSI sequences 
  388.     for insert/delete line (Esc-[-L,M)?  If so, set this to "Y" for a faster 
  389.     display.  (Default is "N", as MSDOS ANSI.SYS does not support these codes; 
  390.     some enhanced console drivers, such as NANSI.SYS, do.  The display will 
  391.     not work properly if you select "Y" with the standard ANSI.SYS.)
  392.  
  393.  
  394. -----------------------------  B. USER OPTIONS  ------------------------------
  395.  
  396.  
  397.      You can change a variety of default settings in your copy of VDE, 
  398. according to your taste.  "Default" means the state assumed when VDE is first 
  399. run, or in the absence of any user commands.
  400.  
  401. Use COMMAND mode (Y/N) - Do you want VDE to use its WordStar-compatible 
  402.     command set?  If not, MenuBar mode is used.  See OPERATING MODES.
  403.  
  404. Autosave interval (min.) - Do you want VDE to save your work to disk auto- 
  405.     matically at intervals?  If so, enter the interval in minutes.  A value of 
  406.     0 turns this feature off.
  407. Preserve BAKup files (Y/N) - Should a backup file (*.BAK) be kept when you save 
  408.     over an existing file?  Choose "Y" to play safe, "N" to save disk space.
  409. Use ^Z as EOF mark (Y/N) - Should an EOF marker (^Z, 1Ah) be considered the 
  410.     end of a file?  MSDOS software should not require this, but some early 
  411.     programs (like their CP/M predecessors) did use this convention.  Normally 
  412.     set this to No: VDE will ignore ^Z on input, and will not add ^Z on 
  413.     output.  If set to Yes, VDE will consider a ^Z encountered on input as the 
  414.     end of the file, and will put ^Z at the end of each file on output.
  415. Exclude COM/EXE files (Y/N) - Normally "Y": executable programs (files with 
  416.     types of .COM or .EXE) will not show in the ^KF directory display (unless 
  417.     the filetype is specified explicitly), and cannot be edited.  This is a 
  418.     protection feature; you can damage such files by trying to edit them.  To 
  419.     disable, set to "N".
  420. Default file mode -  Which of the six file modes (A,W,5,P,X,N) described in 
  421.     VDE.DOC do you want as the default?  (Originally "A".)
  422. Auto mode select filetypes - You can specify four filetypes (or type masks, 
  423.     using "?" wildcards) as exceptions to the above default: for example, you 
  424.     could declare all ".ASM" files to default automatically to "N" mode, or 
  425.     all files ".89?" to "W" mode.
  426.  
  427. Insert mode (I/W/O) - Which insert mode setting do you want to start out with: 
  428.     Insert, Word insert, or Overstrike (insert off)?
  429. Header on (Y/N) - Do you want the header (^OQ) to start out ON?  (Normally Yes)
  430. Ruler on (Y/N) - Do you want the Ruler (^OT) to start out ON?  (Normally No)
  431. HCR display on (Y/N) - Do you want Hard CR display (^OB) to start out ON when 
  432.     editing a Document ("W,A" modes) with VDE?
  433. Hyphenation on (Y/N) - Do you want hyphenation (^OH) to start out ON?
  434. Case-insensitive search (Y/N) - Do you want string searches (^QF) to be case 
  435.     insensitive by default?  Normally, No; if Yes, specifying the "U"ppercase 
  436.     option while using ^QF will force a case SENSITIVE search.
  437.  
  438. Left and Right margin columns (1-255) - Default margin settings for "W/A" 
  439.     modes.  Set both to 1 to disable wordwrap and reformatting entirely.
  440. Reserve status line (Y/N) - Do you want VDE to reserve the bottom (normally 
  441.     25th) screen line for use as a status or function key line by special 
  442.     software?  (Normally No, VDE uses this line for text.)
  443. Scroll overlap (0-255) - This is the number of lines overlap between screens 
  444.     when scrolling: the smaller, the larger the scroll.  Originally set to 2, 
  445.     for a nearly full scroll.  Keep this smaller than your screen size!
  446.  
  447. Ring bell on error (Y/N) - Do you want the bell to ring when a VDE error 
  448.     message displays?
  449. [BkSp] (^H) deletes to left (Y/N) - Do you want the [BackSpace] (^H) key to 
  450.     delete characters?  Originally No - it just moves the cursor left.
  451. [Del] deletes to right (Y/N) - Do you want the [Delete] key to remove the char- 
  452.     acter to the right?  Originally No - it deletes to the left, as in 
  453.     WordStar.  (NOTE: whichever you choose, Ctrl-[Del] will do the opposite.)
  454. [Home,End] move left/right on line (Y/N) - Do you want the [Home] and [End] 
  455.     keys to move to the start or end of the line?  Originally No -- they move 
  456.     to the top or bottom of the screen, as in WordStar 4.
  457.  
  458. Variable tab stops -  Enter up to 8 variable tab stop columns, in ascending 
  459.     order.  Fill unused values with 0.  Defaults: 6, 15, 35, 55.  (Note: hard 
  460.     tabs display at intervals of 8 columns, and cannot be adjusted.)
  461.  
  462. Show time as AM/PM, not 24 hr (Y/N) - Do you want the time stamp to display in 
  463.     12 hour format (AM/PM)?  Originally Yes.  If No, the time shows in 24 hour 
  464.     format.  (Affects AltT command and ^T in print headers.)
  465. European date format (day,month,yr) (Y/N) - Do you want the date to display in 
  466.     European format?  Originally No, meaning US Format (month,day,year).  
  467.     (Affects AltD command and ^D in print headers.)
  468. Show date numerically (Y/N) - Do you want AltD to enter the date numerically 
  469.     (eg 1/15/88)?  Originally No, meaning verbose (eg January 15, 1988).
  470.  
  471.  
  472. -------------------------  C. PRINTER INSTALLATION  --------------------------
  473.  
  474.  
  475.      Printers vary enormously.  VDE can accomodate two printer drivers, each 
  476. of which can be installed to take advantage of your printer's special 
  477. features.  (Within VDE, the AltV command can be used to select the driver to 
  478. use when printing.)  The defaults installed in VDE are a standard "IBM/Epson 
  479. FX" driver, and a "Simple" driver that can send plain text to any printer, but 
  480. does not support any print controls other than underline and strikeout.  These 
  481. and several other pre-defined drivers can be selected from a menu within 
  482. VINSTALL.  In addition, you can modify either of the drivers, or create your 
  483. own.  (To modify the Alternate driver, you must temporarily make it the 
  484. selected one.)
  485.      If your printer is not on the driver menu, but emulates or resembles one 
  486. that is, start out using that driver, and refine it as needed.  Failing this, 
  487. you must simply refer to your printer manual and install all the necessary 
  488. codes yourself.
  489.      Space for the special print effect codes is limited; you can't install 
  490. lengthy sequences of multiple commands.  You will probably have to stick to 
  491. ONE individual effect (eg, boldface on/off) per print code.
  492.  
  493.               NOTE: If you have to create or SIGNIFICANTLY modify a 
  494.          driver for use with your printer, please send me the data 
  495.          so that I can revise or add a new driver for it.  Drop me a 
  496.          postcard, or Email your VDP file to my CompuServe ID.
  497.  
  498.      VINSTALL can use special Printer Installation files to store and retrieve 
  499. other printer definitions.  These should have a file type of ".VDP".  You have 
  500. the option to read in or write out such a file, as well as editing the 
  501. following values individually.  This makes it easy to save your installation 
  502. and to pass it along to others.
  503.  
  504. Printer ID - Identify the printer you are installing.  (16 characters)
  505.  
  506. IBM graphics printer (Y/N) - Normally No; if you can print the IBM extended 
  507.     ASCII characters, set this to Yes.  If No, VDE will "emulate" graphics on 
  508.     printing, choosing standard character overstrikes that come close.
  509. Send LF after CR (Y/N) - Normally Yes.  But with some printers, which manufac- 
  510.     ture their own LF on receiving a CR, you will want No here.
  511.  
  512. Page length (0-255) - Set the number of text lines to print on a page.  (Does 
  513.     not include another 3 lines for a header or page number, if used.)
  514. Top margin (0-255) - Set the number of blank lines to skip as a top margin 
  515.     before printing each page.  This value (not included in the page length) 
  516.     can be used to position the paper properly.  Default is 0.
  517. Reserve space for header (Y/N) - Default is Yes; when printing without header 
  518.     or page number, 3 blank lines will be kept clear of text on each page, so 
  519.     that the physical page layout is the same.  If No, an additional 3 lines 
  520.     of text will print.
  521. Left margin (0-255) - Set the number of blank columns to skip as a left margin 
  522.     before printing each line.  Useful if you can't set the margin on your 
  523.     printer with an initialization string.  Default is 0.
  524.  
  525. Printer initialization - Enter an optional string of code (#),bytes to send to 
  526.     the printer before each print job, to set default margins, print modes etc.
  527.     (NOTE: the ^KP command has an option to specify additional codes at print 
  528.     time.  See PRINTING.)
  529. Printer deinitialization - Enter another string (#),bytes to send to the 
  530.     printer after each print job, to restore printer to desired state on exit.
  531.  
  532. Proportional printing - Enter the codes needed to set your printer for 
  533.     proportional printing, when ^OJ is engaged, and then to turn this off.  
  534.     Both strings are entered as (#),bytes.
  535.  
  536. Codes for toggles (on/off) - For six of the seven printer toggles (not ^X), 
  537.     you need to tell VDE the codes to send to your printer to produce the 
  538.     desired effect, then turn it off again.  The conventional meanings of the 
  539.     toggles are:      ^B  boldface         ^Y  italic/ribbon
  540.                       ^D  doublestrike     ^T  superscript
  541.                       ^S  underline        ^V  subscript
  542.     but you can use them for anything you want.  Example: IBM/Epson printers 
  543.     require three-byte sequences to turn continuous underlining on and off:
  544.            Underline on    Esc - 1     hex 1B 2D 31   dec 27 45 49
  545.                     off    Esc - 0         1B 2D 30       27 45 48
  546.     You would enter the hex data, starting with the byte count:
  547.               Underline (^PS) on [07]:  (03)1B2D31
  548.                       ...and off [07]:  (03)1B2D30
  549.     You should find the necessary ASCII hex codes in your printer manual.
  550.          (NOTES: ^PS will underline text by overstriking with "_" if you do 
  551.     not install printer codes for it.  The ^PX toggle, for strikeout, requires 
  552.     no installation at all.)
  553.  
  554. Codes for switches - The same idea, but for switches, which send the same 
  555.     codes every time they are used.  WordStar calls the switches:
  556.          ^P^Q  user1  \
  557.            ^W  user2   \ (no standard      ^A  alternate pitch
  558.            ^E  user3   /  meaning)         ^N  normal pitch
  559.            ^R  user4  /
  560.     but once again, you can use them for anything you want: fonts, etc.
  561.  
  562.  
  563. --------------------------  D. DEFAULT MACRO KEYS  ---------------------------
  564.  
  565.  
  566.      VDE has a set of 36 Macro Keys (available in command mode only!), corres- 
  567. ponding to the commands Esc0...9 and EscA...Z.  The default macro definitions 
  568. are those attached to these commands when VDE is first entered.  By changing 
  569. them you can configure VDE to suit your own specialized writing requirements.  
  570. (Any Keys defined with Esc] while using VDE override these defaults.)
  571.  
  572.                NOTE: If you have favorite macros or macro programs, 
  573.          please consider sharing them with other users of VDE.  Drop 
  574.          me a postcard, or Email your macros to my CompuServe ID.
  575.  
  576.      VINSTALL can use Key Definition files to store macro key sets.  These 
  577. should have a file type of ".VDK", for ease of identification.  You have the 
  578. option to read in or write out such a file, as well as editing the keys 
  579. individually.  (VDK files can also be read or saved with VDE's AltU command, 
  580. but only VINSTALL can display the definitions.)
  581.      VINSTALL gives you a display much like this:
  582.  
  583.       Macro Keys:  (___ bytes free)      <---- note room (up to 982)
  584.       [Esc0]<>
  585.       [Esc1]<>                           <---- "<>" flag means empty
  586.       [Esc2]<>
  587.       [Esc3]^[;^C                        <---- normal macro key
  588.       [Esc4]<>
  589.       [Esc5]<N>World Wide Widgets Inc.   <---- "<N>" flag means no-rpt key
  590.       [Esc6]<>
  591.       [Esc7]<Q>^QR^KB^QC^KK^KC           <---- "<Q>" flag means quiet key
  592.       [Esc8]<>
  593.       [Esc9]<>
  594.  
  595. Just select the number of the Key you want to redefine, then type in the new 
  596. definition, much as you would in VDE.  All the same rules apply (but VINSTALL 
  597. will accept longer keys, up to 128 bytes).  If the new definition is too long 
  598. to fit it will be rejected.
  599.      There are several different ranges of keys, which can be displayed and 
  600. modified in a range of 10 at a time (for example, keys 0-9, or A-J).
  601.      VDE.ARC comes with a macro key file EXAMPLES.VDK, containing several 
  602. macros discussed above under MACROS and MACRO PROGRAMMING:
  603.  
  604.      [Esc0]<Q>^QR^NAltD^OF                         ;put date at top right
  605.      [Esc1]<Q>^QS^S^S^[= [^D^D                     ;move to start of paragraph
  606.      [Esc2]<Q>^[~.1^S^[1^[~.<^[2^D^[= 2^[=^M2      ;move to start of sentence
  607.      [Esc3]<Q>^QS^X^[=^M]^S^V ^V^D^[![             ;soften hard-CR paragraph
  608.      [Esc4]<Q>^S^[~ 2^[1^G^S^[= 1^[2^G^S^[~ 2^D    ;delete word to left
  609.  
  610. (Note that "Esc" displays as "^[".)
  611.  
  612.  
  613. -------------------------  E. DEFAULT FUNCTION KEYS  -------------------------
  614.  
  615.  
  616.      VDE also has a set of 40 Function Keys (available in command mode only!), 
  617. corresponding to the [F1]...[F10] keys in their normal, Shift-, Ctrl-, and 
  618. Alt- usage (sometimes referred to collectively as [F1]...[F40]).  These are 
  619. identical in features and functions to the Macro Keys discussed above.  You 
  620. can easily configure these to match the standard function-key configuration 
  621. for Wordstar's key overlay, to correspond to Word Perfect function-key usage, 
  622. or in any other way you like.
  623.      VINSTALL can use Function Key Definition files to store function-key 
  624. sets.  These should have a file type of ".VDF", for ease of identification.  
  625. You have the option to read in or write out such a file, as well as editing 
  626. the keys individually.  (VDF files can also be read or written with VDE's AltU 
  627. command, but only VINSTALL can display the definitions.)
  628.      VINSTALL gives you a display much like this:
  629.  
  630.       Function keys 1-10:  (___ bytes free)   <---- note room (up to 982)
  631.       [F1]<>
  632.       [F2]<>                                  <---- "<>" flag means empty
  633.       [F3]<>
  634.       [F4]<Q>^OL5^M^OR60^M                    <---- normal function key
  635.       [F5]<>
  636.       [F6]<>
  637.       [F7]<>
  638.       [F8]<>
  639.       [F9]<Q>^PS
  640.       [F0]<Q>^PY
  641.  
  642. This works just like the macro keys above, with four sets of 10 keys to define 
  643. (Normal, Shift, Ctrl, Alt).
  644.      VDE.ARC includes sample function-key files which you can read in to 
  645. define the function keys according to the usage of WordStar or Word Perfect.  
  646. The WordStar 4 default definitions in WS4.VDF are:
  647.  
  648. WS4.VDF      NORMAL      SHIFT        CTRL             ALT
  649.      [F1]     ^J          ^OB          ^QF         Vertical bar graphic
  650.      [F2]     ^U          ^OC          ^QA         Horizontal bar
  651.      [F3]     ^V^PS^V                  ^L          Upper-left corner
  652.      [F4]     ^V^PB^V                  ^QI         Upper-right corner
  653.      [F5]     ^Y          ^KY          ^OL         Lower-left corner
  654.      [F6]     ^T          ^KU          ^OR         Lower-right corner
  655.      [F7]                 ^KV                      Upper T graphic
  656.      [F8]                 ^KC                      Lower T
  657.      [F9]     ^KS         ^KB          ^QS         Left T
  658.      [F0]     ^KD         ^KK          ^QD         Right T
  659.  
  660. The WP.VDF file will not "turn VDE into Word Perfect", but it does provide a 
  661. considerable degree of keystroke compatibility.  You can assign any other 
  662. functions desired to unused keys (eg, [F9]).
  663.  
  664. WP.VDF       NORMAL      SHIFT        CTRL             ALT
  665.      [F1]     ^U         Esc?Y        AltR
  666.      [F2]     ^QF                                      ^QA
  667.      [F3]     ^J                      Esc?C            ^OD
  668.      [F4]    ^I^OL^M                  Esc?B           Esc?B
  669.      [F5]     ^KF        AltD                          ^PZ
  670.      [F6]    ^V^PB^V      ^OC                          ^OF
  671.      [F7]    Esc?E       Esc?P
  672.      [F8]    ^V^PS^V     Esc?T        Esc?S           Esc?S
  673.      [F9]
  674.      [F0]     ^KS        Esc?F        Esc[
  675.  
  676.  
  677.  
  678. --------------------------  F. GRAPHICS CHARACTERS  --------------------------
  679.  
  680.  
  681.      VDE allows text to contain a limited, but variable, set of 32 characters 
  682. in the range 80-FFh (on an IBM PC, these are typically graphics or foreign 
  683. characters; see GRAPHICS).  VINSTALL lets you specify your own default 
  684. graphics set.  Keep a fair amount of space free in it if you frequently work 
  685. with files with many graphics characters, in order to avoid overflowing the 
  686. table.
  687.  
  688.      You will be shown the current definitions, in the same format as the VDE 
  689. Graphics command.  Here, however, you can select any entry to redefine (A-Z, 
  690. 1-5) whether vacant or not; furthermore, you may type "-" to clear them all.  
  691. (Graphic 6 cannot be changed; it always remains a fuzzy block.)  In VINSTALL, 
  692. new graphic codes must be entered by hex value, from 80 to FF; a full list of 
  693. graphics characters can be displayed for your selection if you need it, by 
  694. typing "?".  An entry of 00 (or simply pressing [Ret]) means "free" or 
  695. undefined.
  696.      Note that your Printer Installation determines how graphics will print.
  697.  
  698.  
  699.  
  700. ---------------------------  G. CHARACTER WIDTHS  ----------------------------
  701.  
  702.  
  703.      In order to judge the margins correctly when formatting, VDE's 
  704. proportional printing feature (^OJ) needs to know how wide each character is 
  705. when it prints.  The default width table will probably work fairly well with 
  706. any standard ASCII font (eg, "m" is wider than "i", and so on).
  707.      If you would like to fine-tune this table to correspond to your own 
  708. printer instead, you can measure your own font and modify the width table as 
  709. needed.  (You must know the character widths in 1/256"; the easiest way to get 
  710. this is to print out a line of 64 of each character, measure the length in 
  711. multiples of 1/16", and divide by 4.  The result is typically between 10 and 
  712. 30.)  Just type the character, then enter the width as a decimal value.
  713.      Note that this doesn't affect how your printer operates -- just how VDE 
  714. judges the length of each line for wordwrap, when ^OJ is on.
  715.  
  716.  
  717.  
  718. ---------------------------  H. RESTORE DEFAULTS  ----------------------------
  719.  
  720.  
  721.      This option on the VINSTALL menu is provided in the event that you want 
  722. to undo any changes that you (or someone else) has made to your copy of VDE.  
  723. This should return VDE to the state it was distributed in: installation for 
  724. IBM PC, all User Options restored to their defaults, printer driver set to 
  725. Simple, no Macro or Function Keys, original Graphics characters and Character 
  726. widths.
  727.  
  728.  
  729.  
  730.  
  731. ------------------------------------------------------------------------------
  732.  
  733.          ---  Eric Meyer, 401 12th Ave SE #139, Norman OK 73071  ---
  734.  
  735. ===================================[end]======================================
  736.